home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 4 / Amiga Tools 4.iso / tools / internet-tools / connect-line / cl / devkit / docs / clonline.doc < prev    next >
Encoding:
Text File  |  1995-11-13  |  38.6 KB  |  1,520 lines
  1. TABLE OF CONTENTS
  2.  
  3. clonline.library/CLONL_Open
  4. clonline.library/CLONL_Close
  5. clonline.library/CLONL_FlushInput
  6. clonline.library/CLONL_FlushOutput
  7. clonline.library/CLONL_UpdateUser
  8. clonline.library/CLONL_Normal
  9. clonline.library/CLONL_DeleteEOL
  10. clonline.library/CLONL_DeleteLine
  11. clonline.library/CLONL_InsertLine
  12. clonline.library/CLONL_BlueMode
  13. clonline.library/CLONL_GotoXY
  14. clonline.library/CLONL_Color
  15. clonline.library/CLONL_ClearScreen
  16. clonline.library/CLONL_BlueRead
  17. clonline.library/CLONL_Wait
  18. clonline.library/CLONL_DrawTitle
  19. clonline.library/CLONL_Edit
  20. clonline.library/CLONL_RequesterSelect
  21. clonline.library/CLONL_GetLocale
  22. clonline.library/CLONL_GetCatalog
  23. clonline.library/CLONL_GetUserShell
  24. clonline.library/CLONL_IsTTY
  25. clonline.library/CLONL_GetString
  26. clonline.library/CLONL_VPrintf
  27. clonline.library/CLONL_VSPrintf
  28. clonline.library/CLONL_DoCommand
  29. clonline.library/CLONL_SendMail
  30. clonline.library/CLONL_GetKey
  31. clonline.library/CLONL_FreeRange
  32. clonline.library/CLONL_ParseExpression
  33. clonline.library/CLONL_Transfer
  34. clonline.library/CLONL_GetUserFullName
  35. clonline.library/CLONL_GetNameVal
  36. clonline.library/CLONL_IsKeyPressed
  37. clonline.library/CLONL_Continue
  38. clonline.library/CLONL_AddShortMenu
  39. clonline.library/CLONL_FreeShortMenu
  40. clonline.library/CLONL_ShortMenuSelect
  41. clonline.library/CLONL_TimeToStr
  42. clonline.library/CLONL_StrToTime
  43. clonline.library/CLONL_AddGadget
  44. clonline.library/CLONL_GetGadget
  45. clonline.library/CLONL_InputMask
  46. clonline.library/CLONL_ShortMenuSelectVertical
  47. clonline.library/CLONL_XFer
  48. clonline.library/CLONL_FreeXFerList
  49. clonline.library/CLONL_SetObscure
  50. clonline.library/CLONL_PrintFile
  51. clonline.library/CLONL_Open                      cl_online.library/CLONL_Open
  52.  
  53.    NAME   
  54.         CLONL_Open -- Startup online system (need to be called)
  55.  
  56.    SYNOPSIS
  57.         status = CLONL_Open ( catalogname )
  58.         D0                    A0
  59.  
  60.         BOOL     CLONL_Open ( STRPTR )
  61.  
  62.    FUNCTION
  63.         Opens some libraries used for nearly all cl actions and inits
  64.         them. Sets console to raw mode, that user can use unbuffered
  65.         stdio (e.g. FGetC() from dos.library). It had to be used
  66.         before the first use of any functions of this library. You
  67.         should close with CLONL_Close() at the end of your programm.
  68.         catalogname specifices the name of the clcat file for
  69.         different languages.
  70.    
  71.    INPUTS
  72.         catalog - a pointer to the name of the clcat file of users
  73.                   command.
  74.                   REXX<x> - Takes global shell enviroment and loads
  75.                             no catalog. <x> is portnummer.
  76.                   NULL - no catalog will be loaded. You cannot use
  77.                          catalog functions than.
  78.    
  79.    RESULTS
  80.         status  - TRUE (1)  if anything was ok.
  81.                   FALSE (0) if an error has occured.       
  82.  
  83.    EXAMPLE
  84.  
  85.         struct Library *CLOnlineBase;
  86.  
  87.         int main(int argc, char *argv[])
  88.         {
  89.           if ( !(CLOnlineBase = OpenLibrary ( "clonline.library", 0)) )
  90.           { 
  91.             PutStr ("Can't open clonline.library.\n"); 
  92.             return 20; 
  93.           }
  94.           if ( !CLONL_Open("mycommand.clcat") )
  95.           { 
  96.             PutStr("Can't init ANSI-System.\n"); 
  97.             return 1;
  98.           }
  99.           CLONL_DrawTitle();
  100.           if (CLOnlineBase) CloseLibrary (CLOnlineBase);
  101.         }
  102.    
  103.    NOTES
  104.         if an important error has occured the function will print out
  105.         the reason of the error (e.g. not logged in).
  106.    
  107.    SEE ALSO
  108.         dos.library/SetMode()
  109.         CLONL_Close()
  110.    
  111.    BUGS
  112.  
  113. clonline.library/CLONL_Close                    cl_online.library/CLONL_Close
  114.  
  115.    NAME   
  116.         CLONL_Close -- Close down online system
  117.  
  118.    SYNOPSIS
  119.         CLONL_Close ( )
  120.  
  121.         CLONL_Close ( )
  122.  
  123.    FUNCTION
  124.         Use this function after the last in- or output to close down
  125.         safely.
  126.    
  127.    SEE ALSO
  128.         dos.library/SetMode()
  129.         CLONL_Open()
  130.    
  131.    BUGS
  132.  
  133. clonline.library/CLONL_FlushInput          cl_online.library/CLONL_FlushInput
  134.  
  135.    NAME   
  136.         CLONL_FlushInput - Flushes the input buffer
  137.  
  138.    SYNOPSIS
  139.         CLONL_FlushInput ( )
  140.  
  141.         CLONL_FlushInput ( )
  142.  
  143.    FUNCTION
  144.         Flushes the input buffer to forget all keys pressed before
  145.         user call this function.
  146.  
  147.    SEE ALSO
  148.         CLONL_FlushOutput()
  149.    
  150.    BUGS
  151.  
  152. clonline.library/CLONL_FlushOutput        cl_online.library/CLONL_FlushOutput
  153.  
  154.    NAME   
  155.         CLONL_FlushOutput - Flushes the output buffer
  156.  
  157.    SYNOPSIS
  158.         CLONL_FlushOutput ( )
  159.  
  160.         CLONL_FlushOutput ( )
  161.  
  162.    FUNCTION
  163.         Flushes the output buffer to print out anything which is in
  164.         the actual output buffer.
  165.  
  166.    EXAMPLE
  167.         CLONL_Printf("Cursor after the three points without linefeed...");
  168.         CLONL_FlushOutput();
  169.  
  170.    SEE ALSO
  171.         CLONL_FlushInput()
  172.    
  173.    BUGS
  174.  
  175. clonline.library/CLONL_UpdateUser          cl_online.library/CLONL_UpdateUser
  176.  
  177.    NAME   
  178.         CLONL_UpdateUser - Updates actual users settings
  179.  
  180.    SYNOPSIS
  181.         CLONL_UpdateUser ( )
  182.  
  183.         CLONL_UpdateUser ( )
  184.  
  185.    FUNCTION
  186.         This functions updates the users settings. It is usefull when
  187.         the user has changed his personal settings and they have to
  188.         effect proberly to the others, e.g. the up- or download ratio.
  189.  
  190.    NOTES
  191.         Do not use this function, when there is no really need to
  192.         calls it, because after logoff all the settings will
  193.         automatically be updated.
  194.  
  195.    BUGS
  196.  
  197. clonline.library/CLONL_Normal                  cl_online.library/CLONL_Normal
  198.  
  199.    NAME   
  200.         CLONL_Normal - Set the output style attributes back to normal
  201.  
  202.    SYNOPSIS
  203.         CLONL_Normal ( )
  204.  
  205.         CLONL_Normal ( )
  206.  
  207.    FUNCTION
  208.         Set the output style attributes back to normal. This depents
  209.         on the used terminal.
  210.  
  211.    SEE ALSO
  212.         CLONL_BlueMode()
  213.         CLONL_Color()
  214.    
  215.    BUGS
  216.  
  217. clonline.library/CLONL_DeleteEOL            cl_online.library/CLONL_DeleteEOL
  218.  
  219.    NAME   
  220.         CLONL_DeleteEOL - Deletes line to end of line
  221.  
  222.    SYNOPSIS
  223.         CLONL_DeleteEOL ( )
  224.  
  225.         CLONL_DeleteEOL ( )
  226.  
  227.    FUNCTION
  228.         This functions send the ANSI Code to the users terminal to
  229.         delete til end of line from cursor position.
  230.  
  231.    SEE ALSO
  232.         CLONL_DeleteLine()
  233.         CLONL_InsertLine()
  234.    
  235.    BUGS
  236.  
  237. clonline.library/CLONL_DeleteLine          cl_online.library/CLONL_DeleteLine
  238.  
  239.    NAME   
  240.         CLONL_DeleteLine - Deletes line
  241.  
  242.    SYNOPSIS
  243.         CLONL_DeleteLine ( )
  244.  
  245.         CLONL_DeleteLine ( )
  246.  
  247.    FUNCTION
  248.         This functions sends the ANSI Code to the users terminal to
  249.         delete the actual line an to scroll up the rest of the text.
  250.  
  251.    SEE ALSO
  252.         CLONL_DeleteEOL()
  253.         CLONL_InsertLine()
  254.    
  255.    BUGS
  256.  
  257. clonline.library/CLONL_InsertLine          cl_online.library/CLONL_InsertLine
  258.  
  259.    NAME   
  260.         CLONL_InsertLine - Inserts line
  261.  
  262.    SYNOPSIS
  263.         CLONL_InsertLine ( )
  264.  
  265.         CLONL_InsertLine ( )
  266.  
  267.    FUNCTION
  268.         This functions sends the ANSI Code to the users terminal to
  269.         insert one line at the actual position. The rest of display
  270.         will scroll down.
  271.  
  272.    SEE ALSO
  273.         CLONL_DeleteEOL()
  274.         CLONL_DeleteLine()
  275.    
  276.    BUGS
  277.  
  278. clonline.library/CLONL_BlueMode              cl_online.library/CLONL_BlueMode
  279.  
  280.    NAME   
  281.         CLONL_BlueMode - Sets a special colour mode
  282.  
  283.    SYNOPSIS
  284.         CLONL_BlueMode ( )
  285.  
  286.         CLONL_BlueMode ( )
  287.  
  288.    FUNCTION
  289.         Set the colour and style attributes to a special mode, used
  290.         within the functions CLONL_DrawTitle() and CLONL_BlueRead()
  291.         inside the library. It is usefull for same looking features.
  292.  
  293.    SEE ALSO
  294.         CLONL_Normal()
  295.         CLONL_Color()
  296.         CLONL_DrawTitle()
  297.         CLONL_BlueRead()
  298.    
  299.    BUGS
  300.  
  301. clonline.library/CLONL_GotoXY                  cl_online.library/CLONL_GotoXY
  302.  
  303.    NAME   
  304.         CLONL_GotoXY - Sets cursor to specified position
  305.  
  306.    SYNOPSIS
  307.         CLONL_GotoXY ( x,     y )
  308.                        D0     D1
  309.  
  310.         CLONL_GotoXY ( ulong, ulong )
  311.  
  312.    FUNCTION
  313.         Sets the cursor to a specified position on users screen. You
  314.         can get the maximum lines by calling
  315.         CLONL_GetUserShell()->userprofile.ShowLines.
  316.  
  317.    INPUTS
  318.         x - x coordinate
  319.         y - y coordinate
  320.    
  321.    EXAMPLE
  322.         ulong count;
  323.         for ( count = 1; 
  324.               count <= CLONL_GetUserShell()->userprofile.ShowLines; 
  325.               count++ )
  326.         {
  327.           CLONL_GotoXY ( 1, count);
  328.           CLONL_Printf ( "Line: %2ld", count );
  329.           CLONL_FlushOutput();
  330.         }
  331.    
  332.    NOTES
  333.         The left, upper corner is x = 1, y = 1.   
  334.    
  335.    BUGS
  336.  
  337. clonline.library/CLONL_Color                    cl_online.library/CLONL_Color
  338.  
  339.    NAME   
  340.         CLONL_Color - Definies colour and style
  341.  
  342.    SYNOPSIS
  343.         CLONL_Color ( col,   bcol, style )
  344.                       D0     D1    D2
  345.  
  346.         CLONL_Color ( ulong, ulong, ulong )
  347.  
  348.    FUNCTION
  349.         Defines colour an style for the following text output. The
  350.         colour and style definitions can be found in the include file
  351.         <cl/clonline.h>.
  352.  
  353.    INPUTS
  354.         col   - text colour
  355.         bcol  - background colour
  356.         style - text attributes
  357.    
  358.    EXAMPLE
  359.         CLONL_Color ( COLOR_Red, COLOR_White, STYLE_Bold );
  360.         CLONL_Printf ( "This is very important.\n" );
  361.         CLONL_Normal ();
  362.    
  363.    SEE ALSO
  364.         CLONL_Normal()
  365.         CLONL_BlueMode()
  366.  
  367.    BUGS
  368.  
  369. clonline.library/CLONL_ClearScreen        cl_online.library/CLONL_ClearScreen
  370.  
  371.    NAME   
  372.         CLONL_ClearScreen - Clears the screen
  373.  
  374.    SYNOPSIS
  375.         CLONL_ClearScreen ( )
  376.  
  377.         CLONL_ClearScreen ( )
  378.  
  379.    FUNCTION
  380.         This function will clear the users screen, if his terminal
  381.         makes this possible (e.g. VT100, ANSI). The cursor will also
  382.         be set in the left, upper edge.
  383.  
  384.    BUGS
  385.  
  386. clonline.library/CLONL_BlueRead              cl_online.library/CLONL_BlueRead
  387.  
  388.    NAME   
  389.         CLONL_BlueRead - Gets defined input from user
  390.  
  391.    SYNOPSIS
  392.         str    = CLONL_BlueRead ( str,    def,    len,   type,  maske )
  393.         D0                        A0      A1      D0     D1     D2
  394.  
  395.         STRPTR = CLONL_BlueRead ( STRPTR, STRPTR, ulong, ulong, BOOL  )
  396.  
  397.    FUNCTION
  398.         Makes a line input from user with the a specified length.
  399.         There will be drawn a ANSI Gadget, in the CLONL_BlueMode()
  400.         where the user can type in the needed information.
  401.  
  402.    INPUTS
  403.         str   - the string where to put the result.
  404.         def   - the default string (NULL is not allowed, give an 
  405.                 empty string).
  406.         len   - the length of the input.
  407.         type  - the kind of incoming input (look at clonline.h).
  408.         maske - an internal parameter (must be FALSE (0)).
  409.    
  410.    RESULTS
  411.         str   - the string the user has typed.
  412.  
  413.    EXAMPLE
  414.   char *mystring [ 21 ];
  415.         CLONL_Normal ();
  416.         CLONL_Printf ( "Please gimme your name:" );
  417.         CLONL_BlueRead ( mystring, "nobody", 20, TYPE_ASCII, 0 );
  418.   CLONL_Printf ( "You gave me the name: %s.\n", mystring );
  419.    
  420.    SEE ALSO
  421.         CLONL_BlueMode()
  422.  
  423.    BUGS
  424.  
  425. clonline.library/CLONL_Wait                      cl_online.library/CLONL_Wait
  426.  
  427.    NAME   
  428.         CLONL_Wait - Wait for user to press a key
  429.  
  430.    SYNOPSIS
  431.         result = CLONL_Wait ( )
  432.         D0
  433.  
  434.         BOOL   = CLONL_Wait ( )
  435.  
  436.    RESULTS
  437.         result - TRUE (1) if user want to continue.
  438.                - FALSE (0) if user wants to stop
  439.                  ("q", "Q", "x", "X", <ESC>, <CTRL>"X").
  440.  
  441.    FUNCTION
  442.         This function stops until user pressed a key.
  443.  
  444.    NOTES
  445.         Display looks like it has been before the calls. CLONL_Wait()
  446.         clean up itself.
  447.  
  448.    BUGS
  449.  
  450. clonline.library/CLONL_DrawTitle            cl_online.library/CLONL_DrawTitle
  451.  
  452.    NAME   
  453.         CLONL_DrawTitle - A standart function for look like commands
  454.  
  455.    SYNOPSIS
  456.   CLONL_DrawTitle ( )
  457.  
  458.   CLONL_DrawTitle ( )
  459.  
  460.    FUNCTION
  461.         This function first clears the screen, looks up for the entry
  462.         "INFO_INTROLINE" in the clcat file, this library was opend
  463.         with, and prints it out as a status or title line.
  464.  
  465.    NOTES
  466.         This is the functions all Connectline online commands are
  467.         started with. You can give commands a look of professional. ;)
  468.  
  469.    SEE ALSO
  470.         CLONL_BlueMode()
  471.  
  472.    BUGS
  473.  
  474. clonline.library/CLONL_Edit                      cl_online.library/CLONL_Edit
  475.  
  476.    NAME   
  477.         CLONL_Edit - Edit a file
  478.  
  479.    SYNOPSIS
  480.         result = CLONL_Edit ( filename )
  481.         D0                    A0
  482.  
  483.         BOOL   = CLONL_Wait ( STRPTR   )
  484.  
  485.    INPUTS
  486.         filename - a pointer to the filename, which should be
  487.                    edited.
  488.  
  489.    RESULTS
  490.         result - TRUE (1) if anything got allright.
  491.                - FALSE (0) if user wants to stop or an error
  492.                  has occured. Better to stop work after with
  493.                  returncode.
  494.  
  495.    FUNCTION
  496.         This functions load the Connectline Editor, must be found in
  497.         "CONNECTLINE:Modules/CLEditor", an lets the user edit a file.
  498.  
  499.    NOTES
  500.         You can also use another editor e.g. AEd for exchange,
  501.         but you have to rename it.
  502.         Console user will get the selected offline editor.
  503.  
  504.    EXAMPLE
  505.         CLONL_Printf ( "Please edit the startup-sequence.\n" );
  506.         CLONL_Wait ();
  507.         CLONL_Edit ( "s:startup-sequence" );
  508.         CLONL_Printf ( "Thank you very much.\n");
  509.  
  510.    SEE ALSO
  511.         CONNECTLINE:Modules/CLEditor
  512.  
  513.    BUGS
  514.  
  515. clonline.library/CLONL_RequesterSelectcl_online.library/CLONL_RequesterSelect
  516.  
  517.    NAME   
  518.         CLONL_RequesterSelect - shows an ANSI Requester
  519.  
  520.    SYNOPSIS
  521.         select            = CLONL_RequesterSelect ( entrys,          pos,   titel,  MODE )
  522.         D0                                          A0               D0     A1      D1
  523.  
  524.         struct EntryNode* = CLONL_RequesterSelect ( struct MinList*, ulong, STRPTR, ulong )
  525.  
  526.    INPUTS
  527.         entrys - a pointer to struct MinList to the shown entrys.
  528.         pos    - the position the requester starts (default for user).
  529.         titel  - a pointer the titelbar name.
  530.         MODE   - the modus of the requester (look at includes for "MODE_#?").
  531.  
  532.    RESULTS
  533.         select - a pointer of the entry which has been choosen.
  534.                  -1 for cursor left (only in MODE_CHOOSE).
  535.                  NULL if a break was detected or an error has occured.
  536.  
  537.    FUNCTION
  538.         This functions draws an ANSI Requester, to choose one entry or
  539.         to select multipe.
  540.  
  541.    EXAMPLE
  542.          #include <exec/lists.h>
  543.        
  544.          struct MinList entrylist;
  545.          struct EntryNode *en;
  546.          ulong  count;
  547.        
  548.          char *strings[] = 
  549.          {
  550.           "my personal entry",
  551.            "another entry",
  552.            "the last entry for today",
  553.            0
  554.          };
  555.  
  556.          // Exec function create a new list
  557.          NewList ((struct List *) &entrylist); 
  558.  
  559.          count = 0;
  560.          while (strings [ count ] )
  561.          {
  562.            if ( !(en = malloc ( sizeof(struct EntryNode) )) ) 
  563.            {
  564.              PutStr ( "Can't get memory.\n" ); 
  565.              break; 
  566.            };
  567.            // Fill in new node an add to list
  568.            strcpy ( en->data, strings [ count ] );
  569.            en->inverse = 0;
  570.            en->bold    = 0:
  571.            AddTail ((struct List *) &entrylist, (struct Node *) en);
  572.            count++;
  573.          }
  574.  
  575.          // Show Requester
  576.          CLONL_RequesterSelect(&entrylist, 0, "Look at this amazing requester", MODE_SELECT);
  577.  
  578.          // Free memory again
  579.          while ( en = RemHead ((struct Node *) &entrylist) )
  580.          {
  581.            free(en);
  582.          }
  583.  
  584.    BUGS
  585.  
  586. clonline.library/CLONL_GetLocale            cl_online.library/CLONL_GetLocale
  587.  
  588.    NAME   
  589.         CLONL_GetLocale - returns pointer to locale
  590.  
  591.    SYNOPSIS
  592.         locale           = CLONL_GetLocale ( )
  593.         D0                    
  594.  
  595.         struct Locale *  = CLONL_GetLocale ( )
  596.  
  597.    RESULTS
  598.         locale - pointer to locale.
  599.  
  600.    FUNCTION
  601.         This function returns a pointer to the locale from the
  602.         locale.library.
  603.  
  604.    NOTES
  605.         You should only work with it. Do not close it anyway, because
  606.         CLONL_Close() will do this for you.
  607.  
  608.    SEE ALSO
  609.         locale.library/OpenLocale()
  610.         locale.library/CloseLocale()
  611.  
  612.    BUGS
  613.  
  614. clonline.library/CLONL_GetCatalog          cl_online.library/CLONL_GetCatalog
  615.  
  616.    NAME   
  617.         CLONL_GetCatalog - returns pointer to catalog
  618.  
  619.    SYNOPSIS
  620.         catalog = CLONL_GetCatalog ( )
  621.         D0                    
  622.  
  623.         APTR    = CLONL_GetCatalog ( )
  624.  
  625.    RESULTS
  626.         calalog - pointer to clcat Connectline catalog.
  627.  
  628.    FUNCTION
  629.         This function returns a pointer to the actual user catalog.
  630.  
  631.    NOTES
  632.         You should only work with it. Do not close it anyway, because
  633.         CLONL_Close() will do this for you.
  634.  
  635.    SEE ALSO
  636.         cl_text.library/OpenCatalog()
  637.         cl_text.library/CloseCatalog()
  638.  
  639.    BUGS
  640.  
  641. clonline.library/CLONL_GetUserShell      cl_online.library/CLONL_GetUserShell
  642.  
  643.    NAME   
  644.         CLONL_GetUserShell - returns a pointer to the usershell.
  645.  
  646.    SYNOPSIS
  647.         shell                = CLONL_GetUserShell ( )
  648.         D0                    
  649.  
  650.         struct CLUserShell * = CLONL_GetUserShell ( )
  651.  
  652.    RESULTS
  653.         shell - pointer to user shell.
  654.  
  655.    FUNCTION
  656.         This function returns a pointer to the actual shell of the
  657.         actual online user.
  658.  
  659.    EXAMPLE
  660.         CLONL_Printf ( "Username : %s.\n", 
  661.                        CLONL_GetUserShell()->user.Username );
  662.         CLONL_Printf ( "Number Of Lines : %ld.\n",
  663.                        CLONL_GetUserShell()->userprofile.ShowLines );
  664.  
  665.    SEE ALSO
  666.         Include: <cl/cl_user.h>
  667.         Include: <cl/UserShell.h>
  668.  
  669.    BUGS
  670.  
  671. clonline.library/CLONL_IsTTY                    cl_online.library/CLONL_IsTTY
  672.  
  673.    NAME   
  674.         CLONL_IsTTY - Returns, if TTY emulation is on.
  675.  
  676.    SYNOPSIS
  677.         result = CLONL_IsTTY ( )
  678.         D0
  679.  
  680.         BOOL   = CLONL_IsTTY ( )
  681.  
  682.    RESULTS
  683.         result - TRUE (1) if user uses TTY emulation.
  684.                - FALSE (0) if user uses something usefull.
  685.  
  686.    FUNCTION
  687.         This functions returns, if TTY is used.
  688.  
  689.    BUGS
  690.  
  691. clonline.library/CLONL_GetString            cl_online.library/CLONL_GetString
  692.  
  693.    NAME   
  694.         CLONL_GetString - gets a string from the clcat catalog
  695.  
  696.    SYNOPSIS
  697.         string = CLONL_GetString ( entry  )
  698.         D0                         A0
  699.  
  700.         STRPTR = CLONL_GetString ( STRPTR )
  701.  
  702.    INPUTS
  703.         entry - the entry name of the clcat file.
  704.  
  705.    RESULTS
  706.         string - the entry IN the clcat file by the entry.
  707.  
  708.    FUNCTION
  709.         You can localicate your commands with this function, without
  710.         opening cl_text.library.
  711.  
  712.    NOTES
  713.         Because clonline.library will do this for you ;)
  714.  
  715.    EXAMPLE
  716.         PutStr ( "Let's look, what the entry MSG_TEST is:\n" );
  717.         PutStr ( GetString("MSG_TEST") );
  718.         PutStr ( "\n" );
  719.  
  720.    SEE ALSO
  721.         cl_text.library/*
  722.  
  723.    BUGS
  724.  
  725. clonline.library/CLONL_VPrintf                cl_online.library/CLONL_VPrintf
  726.  
  727.    NAME   
  728.         CLONL_VPrintf - prints a localicated, formated string.
  729.  
  730.    SYNOPSIS
  731.         CLONL_VPrintf ( format, args  )
  732.                         A0      A1
  733.  
  734.         CLONL_VPrintf ( STRPTR, APTR )
  735.  
  736.         CLONL_Printf ( format, ... )
  737.  
  738.    INPUTS
  739.         format - a std. c format string.
  740.         args   - arguments to print out.
  741.  
  742.    FUNCTION
  743.         You can print out ANY text you want, like printf, but buffered
  744.         and token-replaced. You do not need to open cl_text.library.
  745.  
  746.    NOTES
  747.         Because clonline.library will do this for you ;)
  748.  
  749.    EXAMPLE
  750.         CLONL_Printf ( "A number : %ld, a string : %s.\n", 1234, "foo" );
  751.  
  752.    SEE ALSO
  753.         cl_text.library/*
  754.         exec.library/DoRawFmt()
  755.  
  756.    BUGS
  757.  
  758. clonline.library/CLONL_VSPrintf              cl_online.library/CLONL_VSPrintf
  759.  
  760.    NAME   
  761.         CLONL_VSPrintf - prints a localicated, formated string into another.
  762.  
  763.    SYNOPSIS
  764.         CLONL_VSPrintf ( to,     format, args  )
  765.                          A0      A1      A2
  766.  
  767.         CLONL_VSPrintf ( STRPTR, STRPTR, APTR )
  768.  
  769.         CLONL_SPrintf ( to, format, ... )
  770.  
  771.    INPUTS
  772.         to     - a pointer to string for the result.
  773.         format - a std. c format string.
  774.         args   - arguments to print out.
  775.  
  776.    FUNCTION
  777.         You can print out ANY text you want into another string, like
  778.         sprintf, but token-replaced. You do not need to open
  779.         cl_text.library.
  780.  
  781.    NOTES
  782.         Because clonline.library will do this for you ;)
  783.  
  784.    EXAMPLE
  785.         CLONL_SPrintf ( mystring, "A number : %ld, a string : %s.\n", 
  786.           1234, "foo" );
  787.  
  788.    SEE ALSO
  789.         VPrintf()
  790.         cl_text.library/*
  791.         exec.library/DoRawFmt()
  792.  
  793.    BUGS
  794.  
  795. clonline.library/CLONL_DoCommand            cl_online.library/CLONL_DoCommand
  796.  
  797.    NAME   
  798.         CLONL_DoCommand - Executes an other online command
  799.  
  800.    SYNOPSIS
  801.         result = CLONL_DoCommand ( cmd,    param )
  802.         D0                         A0      A1
  803.  
  804.         long   = CLONL_DoCommand ( STRPTR, STRPTR )
  805.  
  806.  
  807.    INPUTS
  808.         cmd   - the command name ( full name ).
  809.         param - the parameter for that command.
  810.  
  811.    RESULTS
  812.         result - return code from command, or false if
  813.                  command connot be found (CLONL_DoCommand()
  814.                  will also print out the error per stdio).
  815.  
  816.    FUNCTION
  817.         You can start another online command from the actual one.
  818.  
  819.    EXAMPLE
  820.         CLONL_DoCommand ( "INHALT", "*" );
  821.  
  822.    BUGS
  823.  
  824. clonline.library/CLONL_SendMail              cl_online.library/CLONL_SendMail
  825.  
  826.    NAME   
  827.         CLONL_SendMail - Sends text mail
  828.  
  829.    SYNOPSIS
  830.         result = CLONL_SendMail ( abs,    emp,    bet,    filename, bezid  )
  831.         D0                        A0      A1      A2      A3        A4
  832.  
  833.         ulong  = CLONL_SendMail ( STRPTR, STRPTR, STRPTR, STRPTR,   STRPTR )
  834.  
  835.    INPUTS
  836.         abs      - the sender of the mail ( no need to be the actual user,
  837.                    for demon mails, but take care of it ).
  838.         emp      - the receiver of the mail.
  839.         bet      - the subject of the mail.
  840.         filename - the filename, of file to send.
  841.         bezid    - the message id of reference text.
  842.                    NULL is allowed.
  843.  
  844.    RESULTS
  845.         result - return code from CLMM_SendFile().
  846.  
  847.    FUNCTION
  848.         This functions sends any kind of text mails from anybody to
  849.         anybody. The charset will be converted from ISO to IBM.
  850.  
  851.    EXAMPLE
  852.         CLONL_SendMail ( CLONL_GetUserShell()->user.username,
  853.           "SYSOP", "just testing", "s:startup-sequence" );
  854.  
  855.    SEE ALSO
  856.         cl_mailmaster.library/CLMM_SendFile()
  857.  
  858.    BUGS
  859.  
  860. clonline.library/CLONL_GetKey                  cl_online.library/CLONL_GetKey
  861.  
  862.    NAME   
  863.         CLONL_GetKey - Gets one key from keyboard or remote keyboard
  864.  
  865.    SYNOPSIS
  866.         key  = CLONL_GetKey ( )
  867.         D0
  868.  
  869.         long = CLONL_GetKey ( )
  870.  
  871.    RESULTS
  872.         key - the key which was pressed or parsed keys, e.g.
  873.               CHAR_BREAK when CHAR_CTRLC, CHAR_CTRLX, or a hangup
  874.               was detected, or CHAR_UP, CHAR_DOWN, CHAR_RIGHT,
  875.               CHAR_LEFT if cursorkeys where used.
  876.  
  877.    FUNCTION
  878.         This functions waits for a key, parse it for some events,
  879.         and gives it back to the user.
  880.  
  881.    EXAMPLE
  882.         long mykey;
  883.         {
  884.           mykey = CLONL_GetKey ();
  885.           CLONL_Printf ( "You pressed a %c ( %ld ).\n", mykey, mykey );
  886.         }
  887.         while ( mykey != CHAR_BREAK )
  888.         CLONL_Printf ( "You don't want anymore, sigh!\n" );
  889.  
  890.    SEE ALSO
  891.         dos.library/FGetC ()
  892.  
  893.    BUGS
  894.  
  895. clonline.library/CLONL_FreeRange            cl_online.library/CLONL_FreeRange
  896.  
  897.    NAME   
  898.         CLONL_FreeRange - Gives memory back, that was allocated by
  899.                           CLONL_ParseExpression
  900.  
  901.    SYNOPSIS
  902.         CLONL_FreeRange ( myrange        )
  903.                           A0
  904.  
  905.         CLONL_FreeRange ( struct Range * )
  906.  
  907.    INPUTS
  908.         myrange - a pointer to a struct Range structure given by
  909.                   CLONL_ParseExpression().
  910.  
  911.    FUNCTION
  912.         Frees memory that was allocated by CLONL_ParseExpression().
  913.  
  914.    SEE ALSO
  915.         CLONL_ParseExpression()
  916.  
  917.    BUGS
  918.  
  919. clonline.library/CLONL_ParseExpressioncl_online.library/CLONL_ParseExpression
  920.  
  921.    NAME   
  922.         CLONL_ParseExpression - Parses a expression, needed for
  923.                                 onlinecommands e.g. INHALT, LESEN.
  924.  
  925.    SYNOPSIS
  926.         range          = CLONL_ParseExpression ( parsepattern, maximum )
  927.         D0                                       A0            D0
  928.  
  929.         struct Range * = CLONL_ParseExpression ( STRPTR,       ulong   )
  930.  
  931.    INPUTS
  932.         parsepattern - a stringpointer to the expression to be 
  933.                        parsed.
  934.         maximum      - the maximum value ( needed for expressions
  935.                        like "1-").
  936.  
  937.    RESULTS
  938.         range        - a pointer to a structure struct Range.
  939.                        NULL if it can't be parsed anyway.
  940.  
  941.    FUNCTION
  942.         Parses expressions like "-3,4,7-8,10-" for onlinecommands
  943.         refering to variable numbers.
  944.  
  945.    NOTES
  946.         You need to free the memory after work with 
  947.         CLONL_FreeRange().
  948.  
  949.    EXAMPLE
  950.         struct Range *myrange;
  951.         struct Range *readrange;
  952.  
  953.         myrange = CLONL_ParseExpression ( "-3,4 5, 8-9 15-17 10,6 20-", 1000);
  954.  
  955.         readrange = myrange;
  956.         while ( readrange )
  957.         {
  958.           CLONL_Printf ("%ld - %ld.\n", readrange -> from, readrange -> to );
  959.           readrange = readrange -> next;
  960.         }
  961.  
  962.         CLONL_FreeRange ( myrange );
  963.  
  964.    SEE ALSO
  965.         CLONL_FreeRange()
  966.  
  967.    BUGS
  968.  
  969. clonline.library/CLONL_Transfer              cl_online.library/CLONL_Transfer
  970.  
  971.    NAME   
  972.         CLONL_Transfer - Transfers file to user.
  973.  
  974.    SYNOPSIS
  975.         result = CLONL_Transfer ( filename, sendfilename )
  976.         D0                        A0        A1
  977.  
  978.         long   = CLONL_Transfer ( STRPTR,   STRPTR       )
  979.  
  980.    INPUTS
  981.         filename    - a pointer to a string, which contains the
  982.                       file to be tranfered with its full path.
  983.  
  984.         senfilename - a pointer to a string, which contains the
  985.                       filename the user gets from that file.
  986.  
  987.    RESULTS
  988.         range        - 1 success.
  989.                        0 failed.
  990.  
  991.    FUNCTION
  992.         Transfers a file to user. The transfer protocoll 
  993.         the user has choosen once, will be used.
  994.  
  995.    NOTES
  996.         It can also be used on console-login.
  997.  
  998.    EXAMPLE
  999.         CLONL_Transfer ( "s:startup-sequence", "Look_Inside.txt" );
  1000.  
  1001.    SEE ALSO
  1002.         cl_shell.library/CLSHELL_XFer()
  1003.  
  1004.    BUGS
  1005.  
  1006. clonline.library/CLONL_GetUserFullNamecl_online.library/CLONL_GetUserFullName
  1007.  
  1008.    NAME   
  1009.         CLONL_GetUserFullName - returns e-Mail from user.
  1010.  
  1011.    SYNOPSIS
  1012.         email  = CLONL_GetUserFullName ( email  )
  1013.         D0                               A0
  1014.  
  1015.         STRPTR = CLONL_GetUserFullName ( STRPTR )
  1016.  
  1017.    INPUTS
  1018.         email - a buffer the email of the user will be copied.
  1019.  
  1020.    RESULTS
  1021.         email - the email of the user.
  1022.  
  1023.    FUNCTION
  1024.         Returns the e-Mail of the actual user. It is included
  1025.         with systemname, domainname and realname, e.g.
  1026.         "joe_random@foo.bar.de (Joe Random)".
  1027.  
  1028.    EXAMPLE
  1029.         char email [ 80 ];
  1030.         CLONL_Printf ( "My e-Mail is %s.\n", 
  1031.           CLONL_GetUserFullName ( email ) );
  1032.  
  1033.    SEE ALSO
  1034.         cl_prefs.library/CLP_GetSystemAddress()
  1035.         CLONL_GetUserShell()
  1036.  
  1037.    BUGS
  1038.  
  1039. clonline.library/CLONL_GetNameVal          cl_online.library/CLONL_GetNameVal
  1040.  
  1041.    NAME   
  1042.         CLONL_GetNameVal - returns a identify number of a string.
  1043.  
  1044.    SYNOPSIS
  1045.         ident = CLONL_NameVal ( name   )
  1046.         D0                      A0
  1047.  
  1048.         long  = CLONL_NameVal ( STRPTR )
  1049.  
  1050.    INPUTS
  1051.         name - a pointer to a string.
  1052.  
  1053.    RESULTS
  1054.         ident - a longword value depend on the string.
  1055.  
  1056.    FUNCTION
  1057.         Function returns a ident value for the string name.
  1058.         Usefull for passwords.
  1059.  
  1060.    NOTES
  1061.         It is directly the function from the clutil.library.
  1062.  
  1063.    SEE ALSO
  1064.         clutil.library/CLU_GetNameVal()
  1065.  
  1066.    BUGS
  1067.  
  1068. clonline.library/CLONL_IsKeyPressed      cl_online.library/CLONL_IsKeyPressed
  1069.  
  1070.    NAME   
  1071.         CLONL_IsKeyPressed - Checks if keyboard was hit.
  1072.  
  1073.    SYNOPSIS
  1074.         result = CLONL_IsKeyPressed ( )
  1075.         D0
  1076.  
  1077.         BOOL   = CLONL_IsKeyPressed ( )
  1078.  
  1079.    RESULTS
  1080.         result - TRUE if keboard was hit.
  1081.                  FALSE if keboard was not hit.
  1082.  
  1083.    FUNCTION
  1084.         This function checks keyboard, if user had pressed any key.
  1085.         You can get the key with CLONL_GetKey() afterwards.
  1086.  
  1087.    EXAMPLE
  1088.         long mykey;
  1089.         if ( CLONL_IsKeyPressed () )
  1090.         {
  1091.           mykey = CLONL_GetKey ();
  1092.           CLONL_Printf ( "You pressed the '%c' key.\n", mykey );
  1093.         }
  1094.         else
  1095.         {
  1096.           CLONL_Printf ( "No key is pressed.\n" );
  1097.         }
  1098.  
  1099.    SEE ALSO
  1100.         CLONL_GetKey()
  1101.  
  1102.    BUGS
  1103.  
  1104. clonline.library/CLONL_Continue               clonline.library/CLONL_Continue
  1105.  
  1106.    NAME   
  1107.         CLONL_Continue - Checks break detect.
  1108.  
  1109.    SYNOPSIS
  1110.         result = CLONL_Continue ( )
  1111.         D0
  1112.  
  1113.         BOOL   = CLONL_Continue ( )
  1114.  
  1115.    RESULTS
  1116.         result - TRUE if break was detected.
  1117.                  FALSE if no break detected.
  1118.  
  1119.    FUNCTION
  1120.         This function checks the keyboard, if a key was pressed. 
  1121.         The key will be get, and checked if it is a ,,break'' key 
  1122.         (CHAR_BREAK).
  1123.         For response, a "<BREAK>" will be send to users display.
  1124.         If a hangup is detected function will also return FALSE. 
  1125.  
  1126.    SEE ALSO
  1127.         CLONL_GetKey()
  1128.  
  1129.    BUGS
  1130.  
  1131. clonline.library/CLONL_AddShortMenu       clonline.library/CLONL_AddShortMenu
  1132.  
  1133.    NAME   
  1134.         CLONL_AddShortMenu - Adds a menu entry
  1135.  
  1136.    SYNOPSIS
  1137.         menu               = CLONL_AddShortMenu ( oldmenu,            entry,  hotkey )
  1138.         D0                                        A0                  A1      D0
  1139.  
  1140.         struct Shortmenu * = CLONL_AddShortMenu ( struct Shortmenu *, STRPTR, char   )
  1141.  
  1142.    INPUTS
  1143.         oldmenu - A pointer to the old menu structure. 
  1144.                   NULL if it is the first entry.
  1145.  
  1146.         entry   - A pointer to a string, with name of entry.
  1147.  
  1148.         hotkey  - Character, which is hotkey to select entry later on.
  1149.  
  1150.    RESULTS
  1151.         menu    - Pointer to new menu structure. Only different from
  1152.                   oldmenu getting first entry.
  1153.  
  1154.    FUNCTION
  1155.         This function will add one entry to a short menu structure.
  1156.         You need this structure to make a menu for CLONL_ShortMenuSelect().
  1157.         Free this structure with CLONL_FreeShortMenu() after use.
  1158.  
  1159.    SEE ALSO
  1160.         CLONL_ShortMenuSelect()
  1161.         CLONL_FreeMenuSelect()
  1162.         CLONL_FreeMenuSelectVertical()
  1163.         clonline.h/struct Shortmenu
  1164.  
  1165.    BUGS
  1166.  
  1167. clonline.library/CLONL_FreeShortMenu     clonline.library/CLONL_FreeShortMenu
  1168.  
  1169.    NAME   
  1170.         CLONL_FreeShortMenu - Frees all menu entrys
  1171.  
  1172.    SYNOPSIS
  1173.         CLONL_FreeShortMenu ( menu               )
  1174.                               A0
  1175.  
  1176.         CLONL_FreeShortMenu ( struct Shortmenu * )
  1177.  
  1178.    INPUTS
  1179.         menu - Pointer to struct Shortmenu structure.
  1180.  
  1181.    FUNCTION
  1182.         Frees memory of short menu entrys allocated by CLONL_AddShortMenu().
  1183.  
  1184.    SEE ALSO
  1185.         CLONL_AddShortMenu()
  1186.         clonline.h/struct Shortmenu
  1187.  
  1188.    BUGS
  1189.  
  1190. clonline.library/CLONL_ShortMenuSelect clonline.library/CLONL_ShortMenuSelect
  1191.  
  1192.    NAME   
  1193.         CLONL_ShortMenuSelect - Builds a short menu for user select.
  1194.  
  1195.    SYNOPSIS
  1196.         result = CLONL_ShortMenuSelect ( menu               )
  1197.         D0                               A0
  1198.  
  1199.         char   = CLONL_ShortMenuSelect ( struct Shortmenu * )
  1200.  
  1201.    INPUTS
  1202.         menu - Pointer to a menu structure build with CLONL_AddShortMenu().
  1203.  
  1204.    RESULTS
  1205.         result - result character.
  1206.                  0 for break or hangup.
  1207.                  hotkey when select with carriage return or hotkey.
  1208.  
  1209.    FUNCTION
  1210.         This function builds up a small requester in one line, an user
  1211.         can select one entry build with CLONL_AddShortMenu(). He can
  1212.         choose with cursor keys and carriage return or pressing the
  1213.         entry hotkey.
  1214.  
  1215.    EXAMPLE
  1216.         struct Shortmenu *mymenu = NULL;
  1217.         mymenu = CLONL_AddShortMenu ( mymenu, "onnectline", 'C' );
  1218.         mymenu = CLONL_AddShortMenu ( mymenu, "erberus", 'Z' );
  1219.         mymenu = CLONL_AddShortMenu ( mymenu, "nix", 'U' );
  1220.         CLONL_ShortMenuSelect ( mymenu );
  1221.         CLONL_FreeShortMenu ( mymenu );
  1222.  
  1223.    SEE ALSO
  1224.         CLONL_ShortMenuSelectVertical()
  1225.         CLONL_AddShortMenu()
  1226.         CLONL_FreeShortMenu()
  1227.         clonline.h/struct Shortmenu
  1228.  
  1229.    BUGS
  1230.  
  1231. clonline.library/CLONL_TimeToStr             clonline.library/CLONL_TimeToStr
  1232.  
  1233.    NAME   
  1234.         CLONL_TimeToStr - Converts a time_t value to a string
  1235.  
  1236.    SYNOPSIS
  1237.         string  = CLONL_TimeToStr ( time,   str    )
  1238.         D0                          D0      A0
  1239.  
  1240.         STRPTR  = CLONL_TimeToStr ( time_t, STRPTR )
  1241.  
  1242.    INPUTS
  1243.         time - A time_t value.
  1244.         str  - String greater 18 character length.
  1245.  
  1246.    RESULTS
  1247.         string - Pointer to str.
  1248.  
  1249.    FUNCTION
  1250.         This function converts a time_t value to a readable string.
  1251.         Use CLONL_StrToTime() to make back conversion.
  1252.  
  1253.    EXAMPLE
  1254.         char string [ 18 ];
  1255.         CLONL_Printf ( "Last Call: %s.\n",
  1256.                        CLONL_TimeToStr ( CLONL_GetUserShell()->userprofile.LastCall,
  1257.                         string) );
  1258.  
  1259.    SEE ALSO
  1260.         CLONL_StrToTime()
  1261.         time.h/time_t
  1262.  
  1263.    BUGS
  1264.  
  1265. clonline.library/CLONL_StrToTime             clonline.library/CLONL_StrToTime
  1266.  
  1267.    NAME   
  1268.         CLONL_StrToTime - Converts string to a time_t value
  1269.  
  1270.    SYNOPSIS
  1271.         time   = CLONL_StrToTime ( str,    time     )
  1272.         D0                          A0     A1
  1273.  
  1274.         time_t = CLONL_StrToTime ( STRPTR, time_t * )
  1275.  
  1276.    INPUTS
  1277.         str  - String Pointer to a Date/Time String.
  1278.         time - Pointer to time_t variable.
  1279.  
  1280.    RESULTS
  1281.         time - Result of conversion.
  1282.  
  1283.    FUNCTION
  1284.         This function converts a string in the CLONL_TimeToStr() 
  1285.         Format back to a time_t value.
  1286.  
  1287.    EXAMPLE
  1288.         char string [ 18 ];
  1289.         time_t mytime;
  1290.         CLONL_Printf ( "Time: %s.\n",
  1291.                        CLONL_TimeToStr ( CLONL_StrToTime ( "12.04.1971 12:30", &mytime ),
  1292.                         string ));
  1293.  
  1294.    SEE ALSO
  1295.         CLONL_TimeToStr()
  1296.         time.h/time_t
  1297.  
  1298.    BUGS
  1299.  
  1300. clonline.library/CLONL_AddGadget             clonline.library/CLONL_AddGadget
  1301.  
  1302.    NAME   
  1303.         CLONL_AddGadget - Adds a gadget entry
  1304.  
  1305.    SYNOPSIS
  1306.         CLONL_AddGadget ( mask,    masktype, identifier, buffer, buffersize )
  1307.                           A0       D0        A1          A2      D1
  1308.  
  1309.         CLONL_AddGadget ( Mask **, ulong,    char *,     char *, ulong      )
  1310.  
  1311.    INPUTS
  1312.         mask       - Pointer to Mask **.
  1313.                      Mask * should bei NULL for first entry.
  1314.         masktype   - Entrytype, like Type bei CLONL_BlueRead().
  1315.         identifier - Pointer to identifier name.
  1316.         buffer     - Pointer to buffer for this entry.
  1317.         buffersize - Size of buffer.
  1318.         
  1319.    FUNCTION
  1320.         This function will add one entry to a gadget MaskNode structure.
  1321.         You need this structure to make a mask for CLONL_InputMask().
  1322.  
  1323.    SEE ALSO
  1324.         CLONL_InputMask()
  1325.         clonline.h/struct MaskNode
  1326.         clonline.h/Mask
  1327.  
  1328.    BUGS
  1329.  
  1330. clonline.library/CLONL_GetGadget             clonline.library/CLONL_GetGadget
  1331.  
  1332.    NAME   
  1333.         CLONL_GetGadget - Gets masknode of specified gadget
  1334.  
  1335.    SYNOPSIS
  1336.         masknode          = CLONL_GetGadget ( mask,    identifier )
  1337.                                               A0       A1
  1338.  
  1339.         struct MaskNode * = CLONL_GetGadget ( Mask **, char *     )
  1340.  
  1341.    INPUTS
  1342.         mask       - Pointer to Mask *.
  1343.         identifier - Pointer to identifier name.
  1344.         
  1345.    RESULTS
  1346.         masknode   - Pointer to MaskNode structure.
  1347.  
  1348.    FUNCTION
  1349.         This functions returns pointer to MaskNode structure of a given
  1350.         identifier, set with CLONL_AddGadget().
  1351.  
  1352.    SEE ALSO
  1353.         CLONL_AddGadget()
  1354.         clonline.h/struct MaskNode
  1355.  
  1356.    BUGS
  1357.  
  1358. clonline.library/CLONL_InputMask             clonline.library/CLONL_InputMask
  1359.  
  1360.    NAME   
  1361.         CLONL_InputMask - Builds up a mask variable entrys
  1362.  
  1363.    SYNOPSIS
  1364.         result = CLONL_InputMask ( mask,    title )
  1365.                                    A0       A1
  1366.  
  1367.         BOOL   = CLONL_GetGadget ( Mask **, char *)
  1368.  
  1369.    INPUTS
  1370.         mask       - Pointer to Mask *.
  1371.         title      - Stringpointer to titlename.
  1372.         
  1373.    RESULTS
  1374.         result - TRUE, if entrys finished correct.
  1375.                  FALSE, if break or hangup detected.
  1376.  
  1377.    FUNCTION
  1378.         This functions builds up a mask of variable entrys. It look
  1379.         like lots of CLONL_BlueRead(). User can change up and down with
  1380.         cursorkeys and quit savely with CTRL-Z.
  1381.  
  1382.    EXAMPLE
  1383.         char str1 [ 42 ], str2 [ 7 ];
  1384.         Mask *mask = NULL;
  1385.         strcpy ( str1, "Gadget1" );
  1386.         strcpy ( str2, "123" );
  1387.         CLONL_AddGadget ( &mask, TYPE_ASCII, str1, str1, 40 );
  1388.         CLONL_AddGadget ( &mask, TYPE_NUMBER, str2, str2, 5 );
  1389.         CLONL_InputMask ( mask, "Just testing gadgets..." );
  1390.  
  1391.    SEE ALSO
  1392.         CLONL_AddGadget()
  1393.         CLONL_FreeGadget()
  1394.         CLONL_BlueRead()
  1395.         clonline.h/struct MaskNode
  1396.         clonline.h/Mask
  1397.  
  1398.    BUGS
  1399.  
  1400. clonline.library/CLONL_ShortMenuSelectVertical
  1401.  
  1402.    NAME   
  1403.         CLONL_ShortMenuSelectVertical - Builds a short menu for user select.
  1404.  
  1405.    SYNOPSIS
  1406.         result = CLONL_ShortMenuSelectVertical ( menu               )
  1407.         D0                                       A0
  1408.  
  1409.         char   = CLONL_ShortMenuSelectVertical ( struct Shortmenu * )
  1410.  
  1411.    INPUTS
  1412.         menu - Pointer to a menu structure build with CLONL_AddShortMenu().
  1413.  
  1414.    RESULTS
  1415.         result - result character.
  1416.                  0 for break or hangup.
  1417.                  hotkey when select with carriage return or hotkey.
  1418.  
  1419.    FUNCTION
  1420.         This function builds up a menu, an user can select one entry
  1421.         build with CLONL_AddShortMenu(). He can choose with cursor keys
  1422.         and carriage return or pressing the entry hotkey.
  1423.  
  1424.    EXAMPLE
  1425.         struct Shortmenu *mymenu = NULL;
  1426.         mymenu = CLONL_AddShortMenu ( mymenu, "onnectline", 'C' );
  1427.         mymenu = CLONL_AddShortMenu ( mymenu, "erberus", 'Z' );
  1428.         mymenu = CLONL_AddShortMenu ( mymenu, "nix", 'U' );
  1429.         CLONL_ShortMenuSelectVertical ( mymenu );
  1430.         CLONL_FreeShortMenu ( mymenu );
  1431.  
  1432.    SEE ALSO
  1433.         CLONL_ShortMenuSelect()
  1434.         CLONL_AddShortMenu()
  1435.         CLONL_FreeShortMenu()
  1436.         clonline.h/struct Shortmenu
  1437.  
  1438.    BUGS
  1439.  
  1440. clonline.library/CLONL_XFer                       clonline.library/CLONL_XFer
  1441.  
  1442.    NAME   
  1443.         CLONL_XFer - Transfer or receive a file. 
  1444.  
  1445.    SYNOPSIS
  1446.  
  1447.    INPUTS
  1448.  
  1449.    RESULTS
  1450.  
  1451.    FUNCTION
  1452.  
  1453.    EXAMPLE
  1454.  
  1455.    SEE ALSO
  1456.         CLONL_FreeXFerList()
  1457.         CLONL_Transfer()
  1458.  
  1459.    BUGS
  1460.  
  1461. clonline.library/CLONL_FreeXFerList       clonline.library/CLONL_FreeXFerList
  1462.  
  1463.    NAME   
  1464.         CLONL_FreeXFerList - Give Memory back, got from CLONL_XFer().
  1465.  
  1466.    SYNOPSIS
  1467.  
  1468.    INPUTS
  1469.  
  1470.    RESULTS
  1471.  
  1472.    FUNCTION
  1473.  
  1474.    EXAMPLE
  1475.  
  1476.    SEE ALSO
  1477.         CLONL_FreeXFerList()
  1478.  
  1479.    BUGS
  1480.  
  1481. clonline.library/CLONL_SetObscure           clonline.library/CLONL_SetObscure
  1482.  
  1483.    NAME   
  1484.         CLONL_SetObscure - Make Sysop Display unreadable.
  1485.  
  1486.    SYNOPSIS
  1487.  
  1488.    INPUTS
  1489.  
  1490.    RESULTS
  1491.  
  1492.    FUNCTION
  1493.  
  1494.    EXAMPLE
  1495.  
  1496.    SEE ALSO
  1497.  
  1498.    BUGS
  1499.  
  1500. clonline.library/CLONL_PrintFile             clonline.library/CLONL_PrintFile
  1501.  
  1502.    NAME   
  1503.         CLONL_PrintFile - Types a plain Ascii File to StdOut.
  1504.  
  1505.    SYNOPSIS
  1506.  
  1507.    INPUTS
  1508.  
  1509.    RESULTS
  1510.  
  1511.    FUNCTION
  1512.  
  1513.    EXAMPLE
  1514.  
  1515.    SEE ALSO
  1516.         cl_txt.library/CLTXT_ViewFile() (don't use - may crashing!)
  1517.  
  1518.    BUGS
  1519.  
  1520.